docs: Move documentation to inline comments: GtkLayout
authorGarrett Regier <alias301@gmail.com>
Sat, 6 Nov 2010 16:28:53 +0000 (17:28 +0100)
committerJavier Jardón <jjardon@gnome.org>
Sat, 6 Nov 2010 16:42:00 +0000 (17:42 +0100)
Signed-off-by: Javier Jardón <jjardon@gnome.org>
docs/reference/gtk/tmpl/.gitignore
docs/reference/gtk/tmpl/gtklayout.sgml [deleted file]
gtk/gtklayout.c

index 28b7b357be5602a35f1257cc6c07c3b681f53edd..43c596e87c0139c9d4b0226a7761eb99bbd0fb9a 100644 (file)
@@ -20,6 +20,7 @@ gtkiconview.sgml
 gtkimcontextsimple.sgml
 gtkimmulticontext.sgml
 gtkitemfactory.sgml
+gtklayout.sgml
 gtklinkbutton.sgml
 gtkmessagedialog.sgml
 gtknotebook.sgml
diff --git a/docs/reference/gtk/tmpl/gtklayout.sgml b/docs/reference/gtk/tmpl/gtklayout.sgml
deleted file mode 100644 (file)
index 1b32027..0000000
+++ /dev/null
@@ -1,177 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-GtkLayout
-
-<!-- ##### SECTION Short_Description ##### -->
-
-Infinite scrollable area containing child widgets and/or custom drawing
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-#GtkLayout is similar to #GtkDrawingArea in that it's a "blank slate"
-and doesn't do anything but paint a blank background by default. It's
-different in that it supports scrolling natively (you can add it to a
-#GtkScrolledWindow), and it can contain child widgets, since it's a
-#GtkContainer. However if you're just going to draw, a #GtkDrawingArea
-is a better choice since it has lower overhead.
-</para>
-
-<para>
-When handling expose events on a #GtkLayout, you must draw to 
-GTK_LAYOUT (layout)-&gt;bin_window, rather than to 
-GTK_WIDGET (layout)-&gt;window, as you would for a drawing
-area.
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-#GtkDrawingArea, #GtkScrolledWindow
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
-<!-- ##### SECTION Image ##### -->
-
-
-<!-- ##### STRUCT GtkLayout ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SIGNAL GtkLayout::set-scroll-adjustments ##### -->
-<para>
-
-</para>
-
-@layout: the object which received the signal.
-@arg1: 
-@arg2: 
-
-<!-- ##### ARG GtkLayout:hadjustment ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkLayout:height ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkLayout:vadjustment ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkLayout:width ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkLayout:x ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkLayout:y ##### -->
-<para>
-
-</para>
-
-<!-- ##### FUNCTION gtk_layout_new ##### -->
-<para>
-
-</para>
-
-@hadjustment: 
-@vadjustment: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_layout_put ##### -->
-<para>
-
-</para>
-
-@layout: 
-@child_widget: 
-@x: 
-@y: 
-
-
-<!-- ##### FUNCTION gtk_layout_move ##### -->
-<para>
-
-</para>
-
-@layout: 
-@child_widget: 
-@x: 
-@y: 
-
-
-<!-- ##### FUNCTION gtk_layout_set_size ##### -->
-<para>
-
-</para>
-
-@layout: 
-@width: 
-@height: 
-
-
-<!-- ##### FUNCTION gtk_layout_get_size ##### -->
-<para>
-
-</para>
-
-@layout: 
-@width: 
-@height: 
-
-
-<!-- ##### FUNCTION gtk_layout_get_hadjustment ##### -->
-<para>
-
-</para>
-
-@layout: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_layout_get_vadjustment ##### -->
-<para>
-
-</para>
-
-@layout: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_layout_set_hadjustment ##### -->
-<para>
-
-</para>
-
-@layout: 
-@adjustment: 
-
-
-<!-- ##### FUNCTION gtk_layout_set_vadjustment ##### -->
-<para>
-
-</para>
-
-@layout: 
-@adjustment: 
-
-
-<!-- ##### FUNCTION gtk_layout_get_bin_window ##### -->
-<para>
-
-</para>
-
-@layout: 
-@Returns: 
-
-
index a2589c27f3f1993c7f6bad43e843e2487741d065..2815b642b26a05637bc76cb0ce327b445ea6a69e 100644 (file)
 #include "gtkscrollable.h"
 
 
+/**
+ * SECTION:gtklayout
+ * @Short_description: Infinite scrollable area containing child widgets
+ *   and/or custom drawing
+ * @Title: GtkLayout
+ * @See_also: #GtkDrawingArea, #GtkScrolledWindow
+ *
+ * #GtkLayout is similar to #GtkDrawingArea in that it's a "blank slate"
+ * and doesn't do anything but paint a blank background by default. It's
+ * different in that it supports scrolling natively (you can add it to a
+ * #GtkScrolledWindow), and it can contain child widgets, since it's a
+ * #GtkContainer. However if you're just going to draw, a #GtkDrawingArea
+ * is a better choice since it has lower overhead.
+ *
+ * When handling expose events on a #GtkLayout, you must draw to
+ * GTK_LAYOUT (layout)->bin_window, rather than to
+ * GTK_WIDGET (layout)->window, as you would for a drawing
+ * area.
+ */
+
+
 typedef struct _GtkLayoutChild   GtkLayoutChild;
 
 struct _GtkLayoutPrivate